Kotlin utilities/it.czerwinski.kotlin.util/Try

Try

sealed class Try<out T>

Representation of an operation that might successfully return a value or throw an exception.

An instance of Try may be either a Success or a Failure.

This type is based on scala.util.Try.

Note: Only non-fatal exceptions are caught by the combinators on Try (see NonFatal). Serious system errors, on the other hand, will be thrown.

Parameters

Type of the value of a successful operation.

Types

Companion

object Companion

Functions

filter

abstract fun filter(predicate: (T) -> Boolean): Try<T>

Returns the same Success if the predicate is satisfied for the value. Otherwise returns a Failure.

filterIsInstance

inline fun <R> filterIsInstance(): Try<R>

Returns the same Success casted to type R if it is R. Otherwise returns a Failure.

filterNot

abstract fun filterNot(predicate: (T) -> Boolean): Try<T>

Returns the same Success if the predicate is not satisfied for the value. Otherwise returns a Failure.

filterOrElse

abstract fun filterOrElse(predicate: (T) -> Boolean, throwable: (T) -> Throwable): Try<T>

Returns the same Success if the predicate is satisfied for the value. Otherwise returns a Failure containing the given throwable.

flatMap

abstract fun <R> flatMap(transform: (T) -> Try<R>): Try<R>

Maps value of a Success to a new Try using transform or returns the same Try if this is a Failure.

fold

inline fun <R> fold(successTransform: (T) -> R, failureTransform: (Throwable) -> R): R

Transforms a Success using successTransform or a Failure using failureTransform.

forEach

abstract fun forEach(action: (T) -> Unit)

Runs action if this is a Success. Returns Unit without any action if this is a Failure.

get

abstract fun get(): T

Gets the value of a Success or throw an exception from a Failure.

getOrNull

abstract fun getOrNull(): T?

Gets the value of a Success or null if this is a Failure.

map

abstract fun <R> map(transform: (T) -> R): Try<R>

Maps value of a Success using transform or returns the same Try if this is a Failure.

toEither

abstract fun toEither(): Either<Throwable, T>

Converts this Try to Either.

toOption

abstract fun toOption(): Option<T>

Converts this Try to Option.

transform

inline fun <R> transform(successTransform: (T) -> Try<R>, failureTransform: (Throwable) -> Try<R>): Try<R>

Transforms a Success using successTransform or a Failure using failureTransform.

zip

infix fun <R> zip(other: Try<R>): Try<Pair<T, R>>

Returns Success containing a Pair of values of this and other if both instances of Try are Success. Otherwise returns first Failure.

inline fun <T1, R> zip(other: Try<T1>, transform: (T, T1) -> R): Try<R>

Returns Success containing the result of applying transform to both values of this and other if both instances of Try are Success. Otherwise returns first Failure.